Sphinxでドキュメントの最終更新日を表示する

Sphinxでドキュメントの最終更新日を表示する

最終更新日(ビルドした日)を表示してみました。
Clock Icon2023.11.09

Sphinxは、文章作成ツールのひとつです。 ソースコードの関数コメントからAPIドキュメントを作成したり、reStructuredText形式のテキストドキュメントから、HTMLファイルを作成できます。 拡張機能を利用すれば、Markdown形式のテキストドキュメントも扱えます。

今回は、ドキュメンの最終更新日を表示してみます。

おすすめの方

  • Sphinxでドキュメントの最終更新日を表示したい方

注意

Sphinxで利用するテーマによっては、本記事の内容で最終更新日が表示されない場合があります。

組み込みテーマ名 最終更新日が表示される
alabaster x
classic o
sphinxdoc o
scrolls o
agogo o
traditional o
nature o
haiku o
pyramid o
bizstyle o

Sphinxを使う準備をする

Sphinxを導入する

公式の手順に従って、導入します。

適当なプロジェクトを作成する

公式の手順に従って、適当なプロジェクトを作成します。

sphinx-quickstart docs

テーマを変更する

デフォルトテーマの「alabaster」は、本記事の方法で最終更新日が表示されません。そのため、他のテーマに変更します。

html_theme = "classic"

ビルドする

HTMLサイトをビルドします。

cd docs
make html

ビルド後は、下記のファイルを開いて、確認します。

open build/html/index.html

00_alabaster

ドキュメントの最終更新日を表示する

conf.pyに設定を追加する

conf.pyに次の設定を追加します。

  • html_last_updated_fmt
html_last_updated_fmt = "%Y/%m/%d"

ビルドして結果を確認する

HTMLサイトをビルドします。

cd docs
make html

最終更新日が表示されました(画像は小さいですが、拡大すると見れます)。

02_alabaster

なお、テーマによっては、最終更新日が表示されない場合があります。 組み込みテーマについては、本記事の上部に記載したとおりです。

組み込みテーマの様子

alabaster: 最終更新日は表示されない

01_ alabaster

classic: 最終更新日は表示される

02_alabaster

sphinxdoc: 最終更新日は表示される

03_sphinxdoc

scrolls: 最終更新日は表示される

04_scrolls

agogo: 最終更新日は表示される

05_agogo

traditional: 最終更新日は表示される

06_traditional

nature: 最終更新日は表示される

07_nature

haiku: 最終更新日は表示される

08_haiku

pyramid: 最終更新日は表示される

09_pyramid

bizstyle: 最終更新日は表示される

10_bizstyle

さいごに

Sphinxで最終更新日を表示してみました。 参考になれば幸いです。

参考

この記事をシェアする

facebook logohatena logotwitter logo

© Classmethod, Inc. All rights reserved.